Skip to main content

Clipboards

Clipboards offer a method for maintaining data across various pages by defining a Clipboard along with its freely chosen properties. These properties can be populated with data through SourceLinks or the UI snippet function. Furthermore, the data within these properties can be directly integrated into components using SourceLinks or retrieved using the UI snippet function. This facilitates the easy transfer or modification of form data to another page. Moreover, a Clipboard can be directly filled with data from an entity, provided that the Clipboard's structure matches that of the chosen entity. Through specific SourceLinks events, an entity record can be created, loaded, altered or deleted using its RecordID.

Clipboards are accessible via the submenu under "Frontend." Each project has its defined Clipboards.

[Placeholder: insert screenshot here]

Topbar

In the Clipboard editor, at the top, you will find the topbar. On the left side, there are options to change(1) the project name (double-clicking the project name opens an in-place edit), save the current state of your project (2), or save the project under a different name (3).

On the right side, you can launch the preview (4) or start the project as a real web app (5).

[Placeholder: insert screenshot here]

In the sidebar, you will find a list of all previously defined Clipboards. Additional Clipboards can be defined using the Add button (1). The name of a Clipboard can be changed by double-clicking on its label (2). The Clipboard ID is assigned by the system itself and is always unique to a project. If you want to delete a Clipboard, there' is also a Delete Button (3).

[Placeholder: insert screenshot here]

Content

Clipboard-Properties

Clicking on an entry in the list takes you to the different sections of the Clipboard. When you click on the Data-Properties, you will see all the defined properties in the content area.

[Placeholder: insert screenshot here]

Expanding a property allows you to change the property name, set the value type, and define one or more SourceLinks to load data into the property.

[Placeholder: insert screenshot here]

If you want to add more properties, you can create additional properties by clicking the Create button.

[Placeholder: insert screenshot here]

Entity-Properties

When the "Use Entity" checkbox is activated, you can make settings for communication with entities from the database through Entity Properties.

[Placeholder: insert screenshot here]

Here, you can select the entity with which the Clipboard should communicate (1) and define a record ID that is supposed to be used initially for communication with the entity.

For the Clipboard to interact with the entity, we offer functions through the ApiObject, or you can execute specific actions via SourceLinks. You can set up one or more SourceLinks for the following events (2).

[Placeholder: insert screenshot here]

** Select Row **

This allows you to respond to the Select-Row event in tables. When a select event is triggered, the data is directly assigned to Clipboard properties with the same name and then immediately passed on to all components that have specified the Clipboard as their source in a SourceLink through the input event.

info

Currently, this is only supported by the yTable.

** Commit Create **

When the Clipboard catches a Commit-Create event through the SourceLinks, it attempts to create a new record in the selected entity, using the data from the properties.

info

Currently, this is only supported by the yButton and yLinkButton

** Commit Read **

When the Clipboard catches a Commit-Read event through the SourceLinks, it attempts to load the record with the RecordID (_id) using the Key property and save the data into properties with the same name.

info

Currently, this is only supported by the yButton and yLinkButton

** Commit Update **

When the Clipboard catches a Commit-Update event through the SourceLinks, it attempts to save the data in the properties into the record with the RecordID (_id) using the Key property.

info

Currently, this is only supported by the yButton and yLinkButton

** Commit Delete **

When the Clipboard catches a Commit-Delete event through the SourceLinks, it attempts to delete the record with the RecordID (_id) using the Key property, aiming to remove the data associated with the record.

info

Currently, this is only supported by the yButton and yLinkButton